home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / disk & file tools / shrub / shrub.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  14KB  |  313 lines
  1. @database Shrub
  2. @Author Lee Kindness
  3. @$VER: Shrub_Documentation 1.14
  4. @node Main "Shrub documentation"
  5.   Shrub             *  *    **         [S]mart [H]yperdirectory [R]eader
  6.   =====            ************        [U]nd [B]rancher... well maybe not..
  7.                   ************         
  8.                  ***************       A rather groovy directory tree lister
  9.                   *****************    =====================================
  10.                ********************    
  11.               *********************    Copyright 
  12. Lee Kindness
  13.               ****      | |   ******   =======================
  14.                         | |            
  15.                         | |
  16.  _______________________| |___(This is ment to be a shrub!!!)_______________
  17.            @{" Introduction    " link INTRO}                   @{" Features        " link FEATURES}  
  18.            @{" Usage           " link USAGE}                   @{" Contact         " link CONTACT } 
  19.            @{" Version History " link VERH }                   @{" Ta Billy        " link TABILLY }
  20. @endnode
  21. @remark ********************************************************************
  22. @node INTRO "Introduction"
  23.   So what the hell is Shrub you ask? A database of all available plants in 
  24. the UK - No. A nifty program that helps you maintain the temperatures that
  25. plant seeds need to germinate - I don't think so. Shrub creates directory
  26. listings in a "tree" format.
  27.   If you have used the "Tree" command of MSDOS then you'll know what I'm on
  28. about. Otherwise here goes an explanation : You select a drawer, every file
  29. within this drawer is displayed in a list, if there are other drawers in this
  30. directory then they too will have their contents displayed, and so on. The
  31. output in the list is formated so that it is easy to understand. Eg:
  32.   File1
  33.   File2
  34.   Dir1
  35.     File1.1
  36.     Dir1.1
  37.       File1.1.1
  38.     File1.2
  39.   File3
  40.   File4
  41. Note the indentation makes the listing readable, therefore helping you around
  42. your drawers.
  43. @endnode
  44. @remark ********************************************************************
  45. @node FEATURES "Features"
  46.   There are a number of other directory tree viewers kicking around the 
  47. Amiga PD scene. DTree, PVTree, Directree and Bush (also by me) are some I'm 
  48. aware of. So Why use Shrub?
  49.  1. It's very fast. For a listing of my SYS: partition (10MB, 102 drawers, 
  50.     1254 files) here are the results (approx.) :
  51.      DTree     : 36 (s)
  52.      Directree : 20 (s)
  53.      PVTree    : 10 (s)
  54.      Bush      : 32 (s)
  55.      Shrub     :  4 (s) !!! :)
  56.      
  57.  2. It has a nice WB2/3 user interface. You can even drop icons into Shrub's
  58.     window to get listings. It's not Shell only like DTree and Bush, does 
  59.     not have the horrid Amos GUI of Directree and is a little bit more 
  60.     pratical than PVTree's very nice GUI.
  61.  3. It's packed with features: 
  62.      You can save the listing as ascii text. 
  63.      Choose not to display Workbench icon files.
  64.      Findout how many files and drawers are within a directory.
  65.      Choose if you wish to traverse linked directories.
  66.      View files.
  67.      Alter a files Information.
  68.      Find out if an item is a link, normal file, softlink or even a pipefile.
  69.      You can search the created list for file matches.
  70.  4. It's got a wild name (like a lot of my programs, Publican, Bush, MidMoose,
  71.     WangiPad, NaeGrey, WoofWoof and DQua, I must be out of my heid :).
  72.   Shrub requires Workbench 2 or better to work.
  73. @endnode
  74. @remark ********************************************************************
  75. @node USAGE "Usage"
  76.   Simply double click the icon. @{"Tooltypes" link ARG 5} and @{"program arguments" link ARG} are supported.
  77. If you have WangiPad or Toolmanager installed then you could setup Shrub as a 
  78. Workbench item/object You could then select a directory, select Shrub 
  79. from the pad/dock/menu and get a tree listing of that directory.
  80.   You can the use shift select from workbench to get a directory listing of
  81. the selected drawer or file.
  82.   SHRUB REQUIRES REQTOOLS LIBRARY, IT IS NOT SUPPLIED IN THIS DISTRIBUTION
  83.     Once you've got Shrub on the go you can use the "Project/directory..." 
  84. menuitem to get a listing of a new directory. You can also drag an icon into
  85. the window, the directory that that icon is in will be listed. Items a 
  86. listed in this with their name first followed occasionally by the other 
  87. text. The other stuff means:
  88.   (dir)      : this is a directory
  89.   (dir) <hl> : this is a linked directory
  90.   (dir) <sl> : this is a softlinked directory or file !!
  91.   <hl>       : this is a linked file
  92.   <pipe>     : this is a pipe file??
  93.   If the "Settings/Show Icons?" menuitem is checked then Workbench Info files
  94. (.info) will be shown in the list, if not then they wont!
  95.   If a directory is linked ("(dir <hl>" or "(dir) <sl>") then its contents
  96. will only be shown if the "Settings/Follow Linked Drawers?" menuitem is
  97. checked.
  98.   Double clicking on an item in the list will cause that file to be viewed
  99. if the "Settings/View On Double Click?" menuitem is checked. The viewer
  100. specified thru' the @{"VIEWER" link ARG} option will be used.
  101.   If the "Settings/Info On Double Click?" menuitem is checked then
  102. information on the file will be displayed. The display will be the same as
  103. that obtained thru' Workbench's "Icon/Information..." menuitem. This feature
  104. is only available if you have Workbench 3 or higher... so upgrade to 
  105. Workbench 3.1 now!  
  106.   The "Item" menu also allows the above functions to be used.
  107.   The tree listing can be saved as ascii text thru' the "Project/Save As..."
  108. menuitem. If the "Settings/Create Icons?" menuitem is checked then an icon
  109. will be saved for the created file. 
  110.   A hard copy of the tree listing can be produced by the "Project/Print"
  111. menuitem. The preferences printer settings will be used.
  112.   Some statistics can be viewed via the "Project/Statistics..." memuitem. A 
  113. window will then appear, displaying the name of the drawer that the tree is 
  114. based on; the amount of drawers within this directory; The amount of files in
  115. the directory and the amount of files in the listing (remember .info files 
  116. might not be shown)
  117.   You can search the created list for a particular file using the 
  118. "Search/Find..." menuitem. You can search for all files matching the specified
  119. wildcard (see Amiga documentation for more info). To find a subsequent match
  120. use "Search/Find Next".
  121. @endnode
  122. @remark *********************************************************************
  123. @node ARG "Arguments"
  124. Shell command template:
  125.   DIRECTORY,LEFT/K/N,TOP/K/N,WIDTH/K/N,HEIGHT/K/N,PUBSCREEN/K,SPACETEXT/K,
  126.   LINKS/S,SHOWICONS/S,VIEWODC/S,INFOODC/S,VIEWER/K,FULLSEARCH/S:
  127. Workbench icon tooltypes:
  128.   DIRECTORY
  129.   LEFT
  130.   TOP
  131.   WIDTH
  132.   HEIGHT
  133.   PUBSCREEN
  134.   SPACETEXT
  135.   LINKS
  136.   SHOWICONS
  137.   VIEWODC
  138.   INFOODC
  139.   VIEWER
  140. DIRECTORY
  141.   Initial directory to create tree from on startup.
  142. LEFT,TOP,WIDTH,HEIGHT
  143.   Position and dimensions of the window.
  144. PUBSCREEN
  145.     public screen that the window will open on.
  146. SPACETEXT
  147.   Text that will be used to pub output. Defaults to "  ", "  | " would give
  148.   more emphasis on the directory structure.
  149. LINKS
  150.   If specified then the "Follow Linked Drawers?" menuitem will be checked
  151.   and activated.
  152. SHOWICONS
  153.     If specified then the "Save Icons?" menuitem will be checked and 
  154.     activated.
  155. VIEWODC
  156.     If specified then the "View On Double Click?" menuitem will be checked
  157.   and activated.
  158. INFOODC
  159.     If specified then the "Info On Double Click?" menuitem will be checked
  160.   and activated.
  161. VIEWER
  162.   Specifies the program that is to be used to view files (defaults to 
  163.   MultiView).
  164. EXAMPLES:
  165. Shell:
  166.   Shrub Apps: LEFT=10 PUBSCREEN=HSPASCAL.1 SPACETEXT="  | "
  167. WB tooltypes
  168.   PUBSCREEN=HSPASCAL.1
  169.   LEFT=10
  170.   WIDTH=300
  171.   SPACETEXT=  | 
  172.   DIRECTORY=Apps:
  173.   VIEWER=C:The_Worlds_Best_View_Everything_Util
  174.   VIEWODC
  175. @endnode
  176. @remark ********************************************************************
  177. @node CONTACT "Contact"
  178.   Shrub is written by Lee Kindness. If you wish to contact me for any reason
  179. then here's where you can:
  180. Mail:
  181.                   Lee Kindness
  182.                   8 Craigmarn Road
  183.                   Portlethen Village
  184.                   ABERDEEN AB1 4QR
  185.                   SCOTLAND
  186.                   Wangi 
  187.                   Type somethink like the following on #amiga :
  188.                   
  189.          /me shouts what a <your comments> piece of shrubbery to Wangi :)
  190.                   
  191.   Shrub is not PD, if you find it useful then you should send me something.
  192. Otherwise you could end up a pile of sticky marshmallow after you guilt
  193. caused you to go into melt-down. Or even worse you could be locked up because
  194. of the Wangi Demons flying round your heid, sticking little picks into your
  195. skull, only nobody else sees them. You have been warned!
  196.   So if you do find Shrub useful or are teriffied of the above then what do
  197. you send me? Well Shrub is infact something called GiftWare, you send me 
  198. gift of your choice. 
  199.   If you enclose a SAE or equivelent with your gift then I will send you a 
  200. disk with all the programs written by myself (over 15!!) plus some others.
  201. ... oh and a Warm welcome to the Amiga Scene Escom, hope you want to invest
  202. in the ami... PPC, RTG... would be nice (new amiga's would be nice, forget
  203. C64's :)
  204. LSK _\\//
  205. @endnode
  206. @remark *********************************************************************
  207. @node VERH "Hmmm... interesting Ja, Ja Ja Ja ???"
  208.   Shrub was programmed using Highspeed Pascal by Highsofton an A1200 with
  209. '030 CPU (Viper board), 2+4 MB RAM and 120 MB HD.
  210.   Shrub has been tested using Enforcer.
  211. 1.0  : 09.10.94
  212.      + Initial version.
  213. 1.1  : 11.10.94
  214.      + Added the AppWindow.
  215.      + Added size gadget. (Very crude, it closes the window and then reopens 
  216.        it to the new size. How else can you alter a listview without crudding
  217.        the window?)
  218.      - Removed "Directory..." gadget, just use the menu now.
  219.      
  220. 1.2  : 12.10.94
  221.      + Added requester on quitting.
  222.      + Changed "SPACETEXT/K/F" in the Shell arguments to "SPACETEXT/K" this
  223.        now lets you have a space after any characters in the Spacetext, eg:
  224.        " | " now works.
  225.        
  226. 1.3  : 13.10.94
  227.      + Added the "VIEWER", "LINKS", "INFOODC", "VIEWODC" and "SHOWICONS"
  228.        arguments.
  229.      + Added "Settings/Info On Double Click" and "Settings/View On Double 
  230.        Click" menuitems.
  231.      + Double clicking on an item in the list now gives you info on it and
  232.        views it (depending on above added settings). 
  233.        
  234. 1.4  : 20.10.94
  235.      - Small changes (new version of HSPascal).
  236.      
  237. 1.5  : 21.10.94
  238.      - Default viewer is now "SYS:Utilities/Multiview" rather than "Multiview"
  239.        so that if "SYS:Utilities" is not in the current path it will still 
  240.        work.   
  241.        
  242. 1.6  : 23.10.94
  243.      - "Statistics..." will now state that a drawer is empty rather than saying
  244.        "0 drawers and 0 files".
  245.      - The "Directory" argument now correctly works with drawers again, it
  246.        was using the parent of the drawer.
  247.      - "Print" added.
  248.      - "Save As..." and "Print" 
  249.        - Says in text in directory is empty.
  250.      - "Save As..."
  251.        - Default file name now based on the tree.
  252.        - Full name of the tree drawer is saved in the files comment field.
  253.        - File now a project.
  254.      - Menus rearanged.
  255.      - "Statistics...", "Save As..." and "Print" menu items are now disabled
  256.        if no tree is loaded.
  257.        
  258. 1.7  : 27.10.94
  259.      - All .info files are now masked out when "Settings/Show Icons?" is not
  260.        enabled. .Info files were slipping thru'.
  261.      - Double clicking on an item in the list will now print its fully 
  262.        qualified path and name on the screen titlebar. If the item is a hard
  263.        link then the item it is linked to will also be printed out.
  264.      - "Search" menu added. Has no functionality at present but will in a 
  265.        future version allow the list to be searched for a file/wildcard match.
  266.        
  267. 1.8  : 28.10.94
  268.      - Window is now resized rather than closed and reopened when the zoom
  269.        or size gadgets are used.
  270.        
  271. 1.9  : 30.10.94
  272.      - Search function partially implememted. Has no GUI interface, a console
  273.        window is opened for input/output. All files matching the pattern are
  274.        listed in the console along with their line number. This line number
  275.        can be used with the new "Search/Goto Line..." menuitem to locate the
  276.        item. The "FULLSEARCH" option has been temparally added to specify
  277.        that search results are to be fully qualifified paths.
  278. 1.10 : 06.11.94
  279.      - "Goto Line..." improved, the default value in the requester was 2 less
  280.        than it should have been (thus if you just pressed enter you would be
  281.        2 places further up the list than you should be).
  282.        
  283. 1.11 : 13.12.94
  284.      - When activated from workbench, if shift select is used then the tree
  285.        will be made of the selected icon.
  286.        
  287. 1.12 : 16.12.94
  288.      - Bug fix. Even if no icons were being shift selected Shrub thought they
  289.        were.
  290. 1.13 : 24.04.95
  291.      - Major Revision.
  292.      - Completed search functions/added find next.
  293.      - Removed Goto line item.
  294.      - Added Item menu and its show and info items.
  295.      - Removed the "Directory Tree" text from above the list.
  296.      - Removed MagicWB icons... euch.
  297. 1.14 : 25.04.95
  298.      - Bug fix: Searching enforcer hits and misc. bugs removed.
  299.      - Modified the default values of LEFT and WIDTH.
  300.      - Removed a spelling error (oops :), thanks CStar.
  301.      - Tweeked Shrub.info
  302.      - Improved the info given when a file is double-clicked, if it was a link
  303.        before then it only said "xx hardlink to yy' now it says:
  304.           "xx soft link to yy" or
  305.           "xx hard file link to yy" or
  306.           "xx hard drawer link to yy"
  307. @endnode
  308. @remark *********************************************************************
  309. @node TABILLY "T,T,Ta Billy..."
  310.   Thanks goto Adam Kindness, Tom Pettigew and Jon Pettigrew for daily testing
  311. of my programs... and hi to all on #amiga, (minus fastlane...:)
  312. @endnode
  313.